Skip to content

docs(readme): add config backup and tiny download features#24

Merged
BlackHole1 merged 1 commit into
mainfrom
improve-readme
Jun 15, 2026
Merged

docs(readme): add config backup and tiny download features#24
BlackHole1 merged 1 commit into
mainfrom
improve-readme

Conversation

@BlackHole1

@BlackHole1 BlackHole1 commented Jun 15, 2026

Copy link
Copy Markdown
Member

The README never mentioned the config import/export feature shipped in #18, nor that the app now downloads as a sub-3 MB .dmg. Add both to the Features list and drop the stale MarkdownUI mention from the Architecture section (removed in #21). All nine language variants are updated together to keep the translations in sync.

@BlackHole1
docs(readme): add config backup and tiny download features
7444110 
The README never mentioned the config import/export feature shipped in
#18, nor that the app now downloads as a sub-3 MB .dmg. Add both to the
Features list and drop the stale MarkdownUI mention from the
Architecture section (removed in #21). All nine language variants are
updated together to keep the translations in sync.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 15, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5ebb25e9-d8cf-4a78-8530-13bb34fe2351

📥 Commits

Reviewing files that changed from the base of the PR and between c72fcc5 and 7444110.

📒 Files selected for processing (9)
  • README.md
  • docs/README/README.de.md
  • docs/README/README.es.md
  • docs/README/README.fr.md
  • docs/README/README.ja.md
  • docs/README/README.pt.md
  • docs/README/README.ru.md
  • docs/README/README.zh-CN.md
  • docs/README/README.zh-TW.md

Summary by CodeRabbit

  • Documentation
    • Updated feature descriptions across multiple language versions of the README.
    • Added information about configuration backup—export and import rules to .lockime files with preview of changes before applying.
    • Clarified auto-update and download size details.

Walkthrough

The README and all eight localized variants (de, es, fr, ja, pt, ru, zh-CN, zh-TW) receive two categories of edits. In the Features section, a new "Config backup" bullet is added describing export/import of per-app and per-URL rules to a .lockime file with a pre-apply preview showing additions, conflicts, and removals; the Auto-update bullet wording is adjusted to mention a custom update window; and a "Tiny download" bullet is added or confirmed. In the Architecture section, the LockIME app bullet's integration shims description is updated to remove the MarkdownUI reference, retaining only Sparkle, KeyboardShortcuts, and PermissionFlow.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title follows the required format and accurately describes the main documentation changes in the changeset.
Description check ✅ Passed The description is directly related to the changeset, clearly explaining the purpose of the documentation updates and mentioning specific features and sections affected.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch improve-readme

Comment @coderabbitai help to get the list of available commands and usage tips.

@BlackHole1 BlackHole1 merged commit 6300bf1 into main Jun 15, 2026
3 checks passed
@BlackHole1 BlackHole1 deleted the improve-readme branch June 15, 2026 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@BlackHole1